docs: add installation and running instructions to README#99
Merged
Conversation
Replace the TODO in the 'Running' section with comprehensive instructions covering: - Prerequisites: CA key pair generation with OpenSSL - Running with Docker: full docker run example with volume mounts and environment variables, health check, MySQL/MariaDB alternative - Running as a Gem: gem install, config.ru setup, Itsi initialization, database migration, and server start - Database Setup: ActiveRecord migration instructions - Quick Local Demo: rake local_demo for evaluation Also update the intro paragraph to remove the stale 'will shortly come with Kubernetes examples' language.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replaces the TODO in the
Runningsection with comprehensive installation and running instructions.Changes
New sections under
UsagePrerequisites — Explains the CA key pair requirement (
tls.keyandtls.crt), supported key types (RSA, ECDSA, EdDSA), encrypted PEM format, and certificate chain ordering for intermediate CAs. Includes an OpenSSL example for generating a self-signed root CA.Running with Docker — Full
docker runexample with volume mounts for SSL keys and data persistence, all required environment variables, health check viacurl /ping, and thetrilogy://alternative for MySQL/MariaDB.Running as a Gem —
gem install bullion, then a step-by-step guide to creating a working directory withconfig.ru, Itsi initialization, database migration, and server start with environment variables.Database Setup — ActiveRecord migration instructions for both Docker and gem installations.
Quick Local Demo — Documents the existing
rake local_demotask for evaluation/testing.Intro paragraph update
Removed the stale "will shortly come with Kubernetes examples and even a helm chart" language, since the Docker image is already available and the K8s/helm chart hasn't materialized. Replaced with a cleaner statement about SQLite vs MySQL/MariaDB for production.
Testing
Documentation-only change. No code, tests, or CI behavior affected.
Notes
jgnagy/bullion:latestwhich is published automatically by the release workflow.config.rumatching the one in the repo.local_demoinstructions are accurate as of the current Rakefile.